# Q. What is this file?
# A. This file contains options which allow you to configure your multiworld experience while allowing
#    others to play how they want as well.
#
# Q. How do I use it?
# A. The options in this file are weighted. This means the higher number you assign to a value, the
#    more chances you have for that option to be chosen. For example, an option like this:
#
#    map_shuffle:
#      on: 5
#      off: 15
#
#    Means you have 5 chances for map shuffle to occur, and 15 chances for map shuffle to be turned
#    off.
#
# Q. I've never seen a file like this before. What characters am I allowed to use?
# A. This is a .yaml file. You are allowed to use most characters.
#    To test if your yaml is valid or not, you can use this website:
#        http://www.yamllint.com/
#    You can also verify that your Archipelago options are valid at this site:
#        https://archipelago.gg/check

# Your name in-game, limited to 16 characters.
#     {player} will be replaced with the player's slot number.
#     {PLAYER} will be replaced with the player's slot number, if that slot number is greater than 1.
#     {number} will be replaced with the counter value of the name.
#     {NUMBER} will be replaced with the counter value of the name, if the counter value is greater than 1.
name: Player{number}

# Used to describe your yaml. Useful if you have multiple files.
description: Default Saints Row 2 Template

game: Saints Row 2
requires:
  version: 0.6.7 # Version of Archipelago required for this yaml to work as expected.
  game:
    Saints Row 2: 0.1.0 # Version of the world required for this yaml to work as expected.

Saints Row 2:
  ################
  # Game Options #
  ################
  progression_balancing:
    # A system that can move progression earlier, to try and prevent the player from getting stuck and bored early.
    # 
    # A lower setting means more getting stuck. A higher setting means less getting stuck.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 99
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-0-99: 0 # random value between 0 and 99
    disabled: 0 # equivalent to 0
    normal: 50 # equivalent to 50
    extreme: 0 # equivalent to 99

  accessibility:
    # Set rules for reachability of your items/locations.
    # 
    # **Full:** ensure everything can be reached and acquired.
    # 
    # **Minimal:** ensure what is needed to reach your goal can be acquired.
    full: 50
    minimal: 0

  ################
  # Goal Options #
  ################
  required_gang_arcs:
    # Select which mission chain(s) you need to complete to finish your game.
    # 
    # Available options: Ronin Arc, Sons of Samedi Arc, Brotherhood Arc, Ultor Epilogue
    ['Ronin Arc']

  include_secret_mission_as_goal:
    # Whether to include the secret Ultor mission as part of the completion goal.
    'false': 50
    'true': 0

  ##################################
  # Extra Mission Location Options #
  ##################################
  include_secret_mission:
    # Whether to include the secret Ultor mission in the locations list.
    'false': 50
    'true': 0

  ###############################
  # Activities Location Options #
  ###############################
  include_crowd_control:
    # Whether to include both Crowd Control instances with each level as an individual location check.
    'false': 0
    'true': 50

  include_chop_shop:
    # Whether to include all Chop Shop lists with each vehicle as an individual location check.
    'false': 0
    'true': 50

  include_demo_derby:
    # Whether to include Demolition Derby with each level as an individual location check.
    'false': 0
    'true': 50

  include_drug_trafficking:
    # Whether to include both Drug Trafficking instances with each level as an individual location check.
    'false': 0
    'true': 50

  include_escort:
    # Whether to include both Escort instances with each level as an individual location check.
    'false': 0
    'true': 50

  include_fight_club:
    # Whether to include both Fight Club instances with each level as an individual location check.
    'false': 0
    'true': 50

  include_fuzz:
    # Whether to include both FUZZ instances with each level as an individual location check.
    'false': 0
    'true': 50

  include_fraud:
    # Whether to include both Insurance Fraud instances with each level as an individual location check.
    'false': 0
    'true': 50

  include_heli_assault:
    # Whether to include both Heli Assault instances with each level as an individual location check.
    'false': 0
    'true': 50

  include_hitman:
    # Whether to include all Hitman lists with each target as an individual location check.
    'false': 0
    'true': 50

  include_mayhem:
    # Whether to include both Mayhem instances with each level as an individual location check.
    'false': 0
    'true': 50

  include_races:
    # Whether to include all races as individual location checks.
    # 
    # Each race will include a location for the Bronze, Silver and Gold medal.
    'false': 0
    'true': 50

  include_sewage:
    # Whether to include both Septic Avenger instances with each level as an individual location check.
    'false': 0
    'true': 50

  include_snatch:
    # Whether to include both Snatch instances with each level as an individual location check.
    'false': 0
    'true': 50

  include_torch:
    # Whether to include both Trail Blazing instances with each level as an individual location check.
    'false': 0
    'true': 50

  #################################
  # Collectibles Location Options #
  #################################
  include_cds:
    # Whether to include all 50 CDs as individual location checks.
    'false': 0
    'true': 50

  ################
  # Item Options #
  ################
  trap_chance:
    # Percentage chance that you'll drop a trap item.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 100
    10: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-0-100: 0 # random value between 0 and 100

  bonus_respect_percentage:
    # Percentage of bonus respect points to add to the item pool. Very useful to make it easier to find more respect to progress.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 100
    15: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-0-100: 0 # random value between 0 and 100

  ###########################
  # Item & Location Options #
  ###########################
  local_items:
    # Forces these items to be in their native world.
    []

  non_local_items:
    # Forces these items to be outside their native world.
    []

  start_inventory:
    # Start with the specified amount of these items. Example: "Bomb: 1"
    {}

  start_hints:
    # Start with these item's locations prefilled into the ``!hint`` command.
    []

  start_location_hints:
    # Start with these locations and their item prefilled into the ``!hint`` command.
    []

  exclude_locations:
    # Prevent these locations from having an important item.
    []

  priority_locations:
    # Prevent these locations from having an unimportant item.
    []

  item_links:
    # Share part of your item pool with other players.
    []

  plando_items:
    # Generic items plando.
    []
